Lender Price API
Locking a Loan with LOS / 2. Pull Loan Pipeline From Encompass
In This Topic
    2. Pull Loan Pipeline From Encompass
    In This Topic

    The first step in locking a loan is to retrieve a list of available loans using Encompass to access the ICE Mortgage Technology Platform. Use the Pipeline API to obtain a list of available loans as an array of loan objects. Select your preferred loan from the list.

    You will pass the id of your selected loan object as the Get Loan in the call path (the returned "id" field, bolded in the example response below).

    Path

    /rest/v1/integration/ellie/loan/pipeline

    Headers

    secret

    {{token}}

    Token

    companyid

    {{companyId}}

    Company Id

    Body

    This API uses no body.

    Response

    The API returns an array of loan objects.

    Example Request

    Copy Code 
    curl --location -g '{{protocol}}{{domain}}/rest/v1/integration/ellie/loan/pipeline
--header 'secret: {{token}}' \
--header 'companyid: {{companyId}}' \
--data ''

    Example Response

    Copy Code 
                  {
  "content": [
    {
      "id": "5ff0ed98e189c40001c54120",
      "companyId": "58c30a394cedfd0001cad410",
      "userId": "580a808ce4b0df8cde4a80c1",
      "name": "MAR_MXCY4L",
      "borrowers": [
        {
          "id": "606deceef80ed5b1593550f2",
          "mergeSet": null,
          "firstname": "",
          "lastname": "",
          "middlename": null,
          "sex": null,
          "birthDate": null,
          "title": null,
          "address": {
            "longitude": null,
            "latitude": null,
            "censustract": "",
            "street": "",
            "streetCont": "",
            "city": "",
            "zip": "",
            "zipExt": "",
            "state": "",
            "province": "",
            "county": "",
            "countyName": "",
            "country": "US",
            "countyFips": "",
            "stateFips": ""
          },
          "contactDetails": {
            "email": null,
            "phone": "",
            "fax": null,
            "mobile": null
          },
          "printPositionType": "Borrower",
          "borrowerId": "5ff0ed98e189c40001c5411f"
        }
      ],
      "propertyAddress": {
        "longitude": null,
        "latitude": null,
        "censustract": "",
        "street": "",
        "streetCont": "",
        "city": "Santa Monica",
        "zip": "90405",
        "zipExt": "",
        "state": "CA",
        "province": "",
        "county": "06037",
        "countyName": "",
        "country": "US",
        "countyFips": "",
        "stateFips": ""
      },
      "creationDate": "2021-01-02T22:03:04Z",
      "integrationType": "DUMMY",
      "losName": "",
      "lockId": null,
      "lockStatus": null,
      "loanPurpose": "Purchase",
      "mortgageType": "Conventional",
      "loanAmortizationType": "Fixed",
      "propertyUsageType": "PrimaryResidence",
      "priceDate": null,
      "lockedDate": null,
      "computedExpirationDate": null,
      "lockExpirationDateMarker": null
    }
  ],
  "pageable": {
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    },
    "pageSize": 10,
    "pageNumber": 0,
    "offset": 0,
    "unpaged": false,
    "paged": true
  },
  "totalPages": 1,
  "totalElements": 1,
  "last": true,
  "first": true,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "numberOfElements": 1,
  "size": 10,
  "number": 0,
  "empty": false
}